ODTypeListIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODTypeListIterator

Superclasses
ODObject
Subclasses
none

An object of the ODTypeListIterator class provides access to each element of a type list.

Description
You use a type-list iterator to apply an operation to each element of a type list. For example, a part might use a type-list iterator to enumerate the part kinds that the part supports and write to storage a representation for each one.
Methods of the ODTypeListIterator class return copies of the elements in the type list. This design prevents you from accidentally changing the content of the type list. When you use a type-list iterator, be sure to delete each copied string to avoid a memory leak.
Your part creates a type-list iterator object by calling the type list object's CreateTypeListIterator method (page 800), which returns a reference to a type-list iterator object.
While you are using a type-list iterator, you should not modify or delete the type list that created it. You must postpone adding elements to or removing elements from the type list until after you have deleted the iterator.
For more information on accessing objects through iterators, see "Accessing Objects Through Iterators" on page 473 in OpenDoc Programmer's Guide.

Methods
This section presents summary descriptions of the ODTypeListIterator methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Accessing

First
Begins the iteration and returns a copy of the first element in the type list that created this type-list iterator.
Next
Returns a copy of the next element in the type list that created this type-list iterator.
Iterator Testing

IsNotComplete
Returns a Boolean value that indicates whether the iteration is incomplete.

Methods
First
IsNotComplete
Next